home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / bildschirmschoner / blitzblank_2.60 / english / blitzblank.guide (.txt) next >
Amigaguide Document  |  1996-04-07  |  50KB  |  1,373 lines

  1. @database "BlitzBlank.guide"
  2. @Node MAIN "BlitzBlank 2.60  16.05.95"
  3.   B L I T Z B L A N K   2 . 6 0
  4. @{" What is BlitzBlank? (Features) " link P1}
  5. @{" What BlitzBlank does           " link P2}
  6. @{" Requirements for BlitzBlank?   " link P3}
  7. @{" Installation                   " link P4}
  8. @{" BlitzBlank and BlitzBlankPrefs " link P5}
  9. @{" The GUI of BlitzBlankPrefs     " link P6}
  10. @{" Menus of BlitzBlankPrefs       " link P7}
  11. @{" ARexx commands                 " link P8}
  12. @{" Amiga OS Key shortcuts         " link P9}
  13. @{" Terminating BlitzBlank         " link P10}
  14. @{" Randomizer                     " link randomgen}
  15. @{" Tooltypes/CLI-Parameters       " link parameter}
  16. @{" Technical stuff                " link P11}
  17. @{" Problems?                      " link P12}
  18. @{" Graphic Cards                  " link P13}
  19. @{" Bugs? Ideas for improvement?   " link P14}
  20. @{" Author                         " link P15}
  21. @{" Copyright/Warranty/Cost        " link P16}
  22. @{" Thanks go to...                " link P17}
  23. @{" History                        " link P18}
  24. @{" MUI                            " link mui}
  25. @{" Modules                        " link modules}
  26. @{" Moduleauthors                  " link modauthors}
  27. @{" New modules?                   " link newmods}
  28. @endnode
  29. @node P1 "What is BlitzBlank?"
  30. Description of BlitzBlank:
  31. --------------------------
  32. Well, another screen saver. But this one's got these features:
  33. - AGA/OS 3.0 compatibel
  34. - most modules are graphic card compatible
  35. - modular (soon more Modules) concept
  36. - lots of useful options
  37. - lots of funny modules
  38. - build in mouseblanker (timed or by keystroke)
  39. - nice GUI (style-guide-compliant)
  40. - build in screen mode requester (Commodore forgot in OS 2.0)
  41. - ARexx-Interface
  42. - fully system friendly
  43. - it's own prefs-editor (BlitzBlankPrefs)
  44. - automatic switch-back to black screen if a blanker stops due to heavy
  45.   CPU load
  46. - won't crash if some nasty program opens it's window on the blankscreen
  47. - mouse motion sensitivity adjustable
  48. - "blank now"- and "blank never"-corner (adjustable size)
  49. - monitors the joystick
  50. - flexible random function
  51. - Commodity
  52. - every module can have it's own screen mode (if the module supports it)
  53. - AmigaGuide documentation with context sensitiv help
  54. - Reblanking (module screen will be pushed to front every 5 seconds)
  55. @endnode
  56. @node P2 "What BlitzBlank does"
  57. BlitzBlank does:
  58. ----------------
  59. - screen look enhancement (no burn in possible)
  60. - mouse blanking
  61. - entertainment
  62. - makes other people drool ;)
  63. @endnode
  64. @node P3 "Requirements for BlitzBlank?"
  65. BlitzBlank requirements:
  66. ------------------------
  67. - an Amiga ;-))
  68. - AmigaOS 2.04 or higher (anybody who still uses 1.3 is at a loss)
  69. - @{" MUI " link mui} 2.3
  70. - the following libraries must be present in the LIBS: directory:
  71.   * commodities.library
  72.   * rexxsyslib.library
  73.   * amigaguide.library
  74. @endnode
  75. @node P4 "Installation"
  76. Installation Procedures are as follows:
  77. ---------------------------------------
  78. Automatic Installation:
  79.  1. All previously installed versions of BlitzBlank must be deleted (incl.
  80.     modules).
  81.  2. Start the installation script by double-clicking the "Install" icon.
  82.     If you get the message "Installer not found" or a similar one you have
  83.     to copy the Installer program from you AmigaOS Install-Disc to your
  84.     harddisk into the C: (SYS:C/) directory. If the installer script still
  85.     won't work you should follow the manual installation procedure.
  86.  3. Follow the instructions and answer the questions of the installer.
  87.     Usually you will only have to select "proceed".
  88. Manual Installation:
  89.  1. All previously installed versions of BlitzBlank must be deleted (incl.
  90.     modules).
  91.  2. Copy BlitzBlank to SYS:WBStartup.
  92.  3. Copy the BlitzBlank drawer wherever you like.
  93.  4. Copy Locale/Catalogs/english/blitzblank.catalog to
  94.     Locale:Catalogs/english/ (AmigaOS 2.1 or higher must be installed)
  95.  5. You CAN copy BlitzBlankPrefs to SYS:PREFS but you don't have to.
  96.     If you do BlitzBlank.guide should be copied to S:.
  97.  6. Copy Libs/iff.library and Libs/blitzblank.library to LIBS:.
  98.  7. Start BlitzBlankPrefs.
  99.  8. Enter the path to the modules in the appropriate field (either you
  100.     enter it manually or you can use a file-requestor by clicking the
  101.     gadget at the side of the word "Modulepath".
  102.  9. Click SAVE.
  103. 10. Start BlitzBlank.
  104. 11. If a 68020/030/040 processor is present you can use the files from the
  105.     68020 directory. If an additional mathematic co-processor is present
  106.     you can add the files from 68020+FPU/ or 68040+FPU/.
  107. BlitzBlankPrefs features a context-sensitive help i.e. by pressing the
  108. HELP-key you'll get help concerning the object over which the mouse pointer
  109. is positioned.
  110. For this BlitzBlank.guide must be accessible for BlitzBlankPrefs.
  111. @endnode
  112. @node P5 "BlitzBlank and BlitzBlankPrefs"
  113. BlitzBlank and BlitzBlankPrefs:
  114. -------------------------------
  115. BlitzBlank consists of several parts. The modules, BlitzBlank,
  116. BlitzBlankPrefs and the blitzblank.library.
  117. BlitzBlank is the essential blanker constantly running in the background
  118. and starting the modules.
  119. BlitzBlankPrefs is the preferences editor for BlitzBlank. With it you
  120. determine which module will be started and which options will be used.
  121. Blitzblank.library is the necessary library used by BlitzBlank to
  122. communicate with the modules and to put usefull functions at the module's
  123. disposal.
  124. @endnode
  125. @node P6 "GUI of BlitzBlankPrefs"
  126. GUI of BlitzBlankPrefs:
  127. -----------------------
  128. All parts of the GUI can be manipulated with the mouse as well as
  129. with the underlined letters (also with SHIFT).
  130. Pressing the HELP-key while the mouse pointer is positioned over a certain
  131. gadget invokes the online help regarding this gadget. Pressing the HELP-key
  132. while configurating a module, the documentation regarding this module will
  133. be displayed.
  134. The GUI of BlitzBlankPrefs consists of the following parts:
  135. @{" Save/Use/Cancel-Gadgets " link close}
  136. @{" Module-preferences      " link moduleconfig}
  137. @{" Mouse-preferences       " link mouse}
  138. @{" Options                 " link options}
  139. @{" Corner-preferences      " link corners}
  140. @endnode
  141. @node close "Save/Use/Cancel-Gadgets"
  142. Save/Use/Cancel-Gadgets:
  143. ------------------------
  144. @{" Save   " link save}
  145. @{" Use    " link use}
  146. @{" Cancel " link cancel}
  147. @endnode
  148. @node save "Save/Use/Cancel-Gadgets"
  149. Save:
  150. -----
  151. The current options will be saved permanently and BlitzBlankPrefs is stopped.
  152. @endnode
  153. @node use "Save/Use/Cancel-Gadgets"
  154. The current options will be used but not saved permanently. BlitzBlankPrefs
  155. is stopped.
  156. @endnode
  157. @node cancel "Save/Use/Cancel-Gadgets"
  158. Cancel:
  159. -------
  160. All options will be set back to defaults and BlitzBlankPrefs is stopped.
  161. @endnode
  162. @node moduleconfig "Module-preferences"
  163. Module-preferences:
  164. -------------------
  165. @{" Module-list " link modulelist}
  166. @{" Prefskey    " link prefskey}
  167. @{" Blankkey    " link blankkey}
  168. @{" Blanktime   " link blanktime}
  169. @{" Randomtime  " link randomtime}
  170. @{" ModPath     " link modpath}
  171. @{" ModPri      " link modpri}
  172. @{" Test        " link test}
  173. @{" Config      " link config}
  174. @endnode
  175. @node modulelist "Module-preferences"
  176. Module-list:
  177. ------------
  178. This list contains all installed modules. If the only displayed module is the
  179. built in module (@{" Blackout " link Blackout}) then the module path you entered is wrong.
  180. You can chose your module by clicking on it. Doubleclicking the module
  181. selects/deselects it for the @{" Randomizer " link randomgen}.
  182. @endnode
  183. @node prefskey "Module-preferences"
  184. Prefskey:
  185. ---------
  186. Here you can chose the key combination for invoking BlitzBlankPrefs. If these
  187. keys are pressed simultaniously and BlitzBlank is active BlitzBlankPrefs will
  188. be started.
  189. @endnode
  190. @node blankkey "Module-preferences"
  191. Blankkey:
  192. ---------
  193. Here you can chose the key combination for the instantenious blanking of the
  194. screen. If BlitzBlank is active and these keys are pressed simultaniously
  195. the chosen blank module will be started at once.
  196. @endnode
  197. @node blanktime "Module-preferences"
  198. Blanktime:
  199. ----------
  200. Here you can enter the time that must have passed without mouse movement,
  201. keystroke, etc. before the blank module will be started. If you enter "0"
  202. the blanker is turned off.
  203. @endnode
  204. @node randomtime "Module-preferences"
  205. Randomtime:
  206. -----------
  207. Here you can chose the time of the duration of a single module if you have
  208. selected the @{" Randomizer " link randomgen}. After this time the next module will be started.
  209. If there are less than 2 modules diplayed in bold typeset in the module list
  210. this field is not selectable. If you enter "0" there will be no switching of
  211. modules during blanking.
  212. @endnode
  213. @node modpath "Module-preferences"
  214. ModPath:
  215. --------
  216. Here you must enter the module path (e.g. "dh0:BlitzBlank/Modules/"). If you
  217. enter the wrong path BlitzBlank won't be able to find the modules. By
  218. clicking the little gadget at the side of the field (or by entering CTRL-P)
  219. the filerequester will be started.
  220. @endnode
  221. @node modpri "Module-preferences"
  222. Modpri:
  223. -------
  224. Here you can chose the task priority of the BlitzBlank modules. If you select
  225. a priority less than 0 then it's more likely that the module will be halted
  226. instead of sucking processing time away from other programs. If the module
  227. should stop for some time BlitzBlank will automatically switch to a black
  228. screen (if @{" Watch CPU " link watch} is selected) so the stopped module's graphic won't
  229. burn in.
  230. @endnode
  231. @node test "Module-preferences"
  232. Test:
  233. -----
  234. If you click this gadget BlitzBlankPrefs will transmit the currently
  235. selected options to BlitzBlank and makes BlitzBlank start the current
  236. module. This way you can test changes instantly. Of course this will only
  237. work if BlitzBlank is previously started (if it wasn't a message will be
  238. displayed).
  239. @endnode
  240. @node config "Module-preferences"
  241. Config:
  242. -------
  243. This gadget opens the options window of the currently selected @{" Module " link modules}.
  244. Pressing the HELP-key in this window will display the module's
  245. documentation.
  246. The following non module specific options are available:
  247. Save    - The current preferences will be saved
  248. Test    - Test the current preferences
  249. Screen  - Select the screen mode for this module
  250. Info    - About the module
  251. Presets - Reset the preferences to default values
  252. Cancel  - Leave the window without saving
  253. These options are not available in all modules.
  254. @endnode
  255. @node mouse "Mouse-preferences"
  256. Mouse-preferences:
  257. ------------------
  258. @{" Fuzzy " link fuzzy}
  259. @{" #Keys " link keys}
  260. @{" Time  " link mousetime}
  261. @endnode
  262. @node fuzzy "Mouse-preferences"
  263. Fuzzy:
  264. ------
  265. Here you can adjust the mouse motion sensitivity. If you set it to "0" then
  266. even the slightest tremor is enough to switch off the blanker. If you set
  267. it to "20" you can even drum your fingers on the mouse without the blanker
  268. being turned off.
  269. @endnode
  270. @node keys "Mouse-preferences"
  271. #Keys:
  272. ------
  273. This slider determines after how many key strokes the mouse will be
  274. blanked. You must take into account the fact that the press AND the release
  275. of a key are regarded as TWO keypresses. If the slider value is "0" the
  276. mouse won't be blanked by keystrokes.
  277. @endnode
  278. @node mousetime "Mouse-preferences"
  279. Time:
  280. -----
  281. Here you can chose how much time in seconds will pass until the mouse is
  282. blanked. A mouseclick or a mouse movement will reset the timer. A "0" will
  283. make sure that the mouse won't be blanked due to a timer.
  284. @endnode
  285. @node options "Options"
  286. Options:
  287. --------
  288. @{" Watch CPU      " link watch}
  289. @{" Pass Key       " link passkey}
  290. @{" Joystick-Check " link joystick}
  291. @endnode
  292. @node watch "Options"
  293. Watch CPU:
  294. ----------
  295. This aktivates the CPU load watch of BlitzBlank. It is responsible for the
  296. switch-back to a black 320x200 screen with 1 bitplane if the blanker stops
  297. due to a heavy CPU load of another task.
  298. @endnode
  299. @node passkey "Options"
  300. Pass Key:
  301. ---------
  302. If this option is activated the key that caused the blanker to stop will be
  303. passed thru to the previously activated window. If it is deactivated the
  304. key will directly go to heaven.
  305. Example: Before the blanking an editor was activated. As the timer reaches
  306.          zero BlitzBlank starts the blankmodule. Now the module is stopped
  307.          because you pressed the "G"-key. If the option is activated the
  308.          blanker stops and the "G" appears in the editor window. If the
  309.          option was deactivated the blanker stops and the editor window
  310.          appears without the "G".
  311. @endnode
  312. @node joystick "Options"
  313. Joystick-Check:
  314. ---------------
  315. This option switches the joystick monitoring on and off. If it is
  316. activated joystick action (just like mouse action) will turn off the
  317. blanking or reset the blank timer.
  318. Due to possible problems with some games (until now none were reported)
  319. this option can be turned off.
  320. If you use a dongle (for Real 3D for example), you should turn off
  321. this option.
  322. @endnode
  323. @node corners "Corner-preferences"
  324. Corner-preferences:
  325. -------------------
  326. @{" Size        " link cornersize}
  327. @{" Blank Now   " link blanknow}
  328. @{" Blank Never " link blanknever}
  329. @endnode
  330. @node cornersize "Corner-preferences"
  331. Size:
  332. -----
  333. Here you can adjust the size of the corners for the blank-now and
  334. blank-never option. If the value is set to "1" the mouse pointer has to be
  335. exactly over the cornerpixel for the option to be activated.
  336. @endnode
  337. @node blanknow "Corner-preferences"
  338. Blank Now:
  339. ----------
  340. Here you chose one (or none) of the four corners of the screen. If the
  341. mouse pointer is moved to this position and stays there for a moment the
  342. screen will be blanked at once.
  343. @endnode
  344. @node blanknever "Corner-preferences"
  345. Blank Never:
  346. ------------
  347. Here you chose one (or none) of the four corners of the screen. If the
  348. mouse pointer is moved to this position and stays there for a moment the
  349. screen will never be blanked. The blank timer (@{" Blanktime " link blanktime}) is stopped.
  350. @endnode
  351. @node P7 "Menus of BlitzBlankPrefs"
  352. Menus of BlitzBlankPrefs:
  353. -------------------------
  354. All menue items can also be activated with the key combination that can be
  355. found at their side.
  356. Project/Open:
  357. Loads a previously saved configuration.
  358. Project/Save As:
  359. Saves the current configuration under a selectable name.
  360. Project/About:
  361. Shows informations/copyright.
  362. Project/Quit:
  363. Quit BlitzBlankPrefs without saving the current configuration.
  364. Edit/Reset To Defaults:
  365. Resets BlitzBlank with the default values.
  366. Edit/Last Saved:
  367. Activates the previously saved configuration.
  368. Edit/Restore:
  369. Activates the configuration selected at BlitzBlankPrefs startup.
  370. Settings/Create Icons?:
  371. Determines if an icon is saved with the config-file.
  372. Action/Stop BlitzBlank:
  373. This quits BlitzBlank (not BlitzBlankPrefs).
  374. @endnode
  375. @node P8 "ARexx commands"
  376. ARexx commands:
  377. ---------------
  378. BlitzBlank offers an ARexx port (Name: "BLITZBLANK") with which one can
  379. control BlitzBlank and change the configuration temporarily. The following
  380. instructions are implemented:
  381. Quits BlitzBlank.
  382. BLANK
  383. BlitzBlank starts the current blank module at once.
  384. UNBLANK
  385. BlitzBlank stops the running blank module at once.
  386. RELOAD
  387. Configuration is reloaded.
  388. MODULE=modulename
  389. The name for the current module is selected.
  390. Similar to selecting in the @{" Module-list " link modulelist}.
  391. RANDOMMODULES=Modulname,Modulname,Modulname
  392. The modules for the @{" Randomizer " link randomgen} are selected.
  393. Similar to double clicking in the @{" Module-list " link modulelist}.
  394. PREFSKEY=key
  395. Selects the key combination for BlitzBlankPrefs start.
  396. Similar to the @{" Prefskey " link prefskey} gadget.
  397. BLANKKEY=key
  398. Selects the key combination to start the blank module at once.
  399. Similar to the @{" Blankkey " link blankkey} gadget.
  400. BLANKTIME=sec
  401. Selects the time that will pass till the blank module is started.
  402. Similar to the @{" Blanktime " link blanktime} gadget.
  403. RANDOMTIME=sec
  404. Selects the time a single module runs in the randomizer mode.
  405. Similar to the @{" Randomtime " link randomtime}.
  406. PATH=path
  407. Selects the path to the modules.
  408. Similar to the @{" ModPath " link modpath} gadget.
  409. MODPRI=num
  410. Selects the module's task priority.
  411. Similar to the @{" ModPri " link modpri} slider.
  412. FUZZY=num
  413. Selects the sensitivity regarding mouse motion during blanking.
  414. Similar to the @{" Fuzzy " link fuzzy} slider.
  415. KEYSTROKES=num
  416. Selects the number of keys till the mouse pointer is blanked.
  417. Similar to the @{" #Keys " link keys} slider.
  418. MOUSETIME=sec
  419. Selects the time that will pass till the mouse pointer is blanked.
  420. Similar to the @{" Time " link mousetime} field.
  421. WATCHCPU=YES|NO
  422. Determines whether the CPU load is monitored during blanking or not.
  423. Similar to the @{" Watch CPU " link watch} option.
  424. PASSKEY=YES|NO
  425. Determines if, after the blanking is stopped, the key will be passed
  426. through or not.
  427. Similar to the @{" Pass Key " link passkey} option.
  428. JOYSTICK=YES|NO
  429. Determines whether the joystick is monitored or not.
  430. Similar to the @{" Joystick-Check " link joystick} option.
  431. CORNERSIZE=num
  432. Selects the @{" Size " link cornersize} of the corners.
  433. BLANKNOW=NONE|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT
  434. The blank-now corner is selected. Description can be found in @{" Blank Now " link blanknow}.
  435. BLANKNEVER=NONE|UPPERLEFT|UPPERRIGHT|LOWERLEFT|LOWERRIGHT
  436. The blank-never corner is selected. Description can be found in @{" Blank Never " link blanknever}.
  437. DISABLE
  438. Similar to "Disable" in commodities exchange and deactivates BlitzBlank
  439. ENABLE
  440. Similar to "Enable" in commodities exchange and reactivates BlitzBlank
  441. after a DISABLE.
  442. DEBUG
  443. Starts the current module in a way that it can be only aborted with the
  444. UNBLANK Arexx instruction.
  445. Examples:
  446. rx "ADDRESS 'BLITZBLANK' 'MODULE=Fade'"
  447. (The fade module is configured)
  448. rx "ADDRESS 'BLITZBLANK' 'BLANK'"
  449. (Blanking starts at once)
  450. rx "ADDRESS 'BLITZBLANK' 'BLANKTIME=0'"
  451. (Blanker is deactivated)
  452. rx "ADDRESS 'BLITZBLANK' 'MOUSETIME=5'"
  453. (The mouse pointer will be blanked after 5 seconds of inactivity)
  454. @endnode
  455. @node P9 "Key shortcuts"
  456. AmigaOS Key shortcuts:
  457. ----------------------
  458. AmigaOS uses certain terms to describe key combinations. These are used in
  459. BlitzBlank to describe the prefskey and the blankkey.
  460. Selektion key:
  461. ctrl       = CTRL-key
  462. lshift     = left SHIFT-key
  463. rshift     = right SHIFT-key
  464. lalt       = left ALT-key
  465. ralt       = right ALT-key
  466. lcommand   = left AMIGA-key
  467. rcommand   = right AMIGA-key
  468. Other keys:
  469. esc        = ESC-key
  470. help       = HELP-key
  471. f1 bis f10 = F1- to F10-key
  472. a bis z    = alpha-keys
  473. 0 bis 9    = numeric-keys
  474. To describe a certain key combination any number of
  475. selection key + other key are valid.
  476. Examples:
  477. ctrl esc
  478. ctrl alt f1
  479. lshift lalt a
  480. ctrl lalt ralt help
  481. @endnode
  482. @node P10 "Terminating BlitzBlank"
  483. Terminating BlitzBlank:
  484. -----------------------
  485. - Within BlitzBlankPrefs with the menue item ....
  486. - Start BlitzBlank a second time and answer the requester with "yes"
  487. - With the ARexx instruction QUIT
  488. - With the commodities exchange program of the workbench
  489. @endnode
  490. @node randomgen "Randomizer"
  491. Randomizer:
  492. -----------
  493. BlitzBlank has a build in randomizer.
  494. It can be activated if at least 2 modules of the @{" Module-list " link modulelist} are selected
  495. with a doubleclick (the name then is displayed in a bold typeset).
  496. Then the blank module to start is selected from the list of the bold
  497. displayed modules instead of the normaly selected (selected for random
  498. display = bold, normal selected = blue).
  499. If at least 2 modules are selected (to select less makes obviously no
  500. sense) und a @{" Randomtime " link randomtime} >0 is additionaly entered the modules will be
  501. switched during blanking.
  502. @endnode
  503. @node parameter "Tooltypes/CLI-Parameters"
  504. Tooltypes/CLI-Parameters:
  505. -------------------------
  506. BlitzBlank recognizes the following parameters:
  507. CX_PRIORITY=num
  508. Determines the commodity's priority. Should be 1.
  509. BlitzBlankPrefs accepts the common parameters:
  510. Tooltypes:
  511. CREATEICONS=YES|NO
  512. ACTION=USE|SAVE
  513. CLI-Parameters:
  514. @endnode
  515. @node P11 "Technical stuff"
  516. Some technical information about BlitzBlank:
  517. --------------------------------------------
  518. - BlitzBlankPrefs uses the same look as the system prefs.
  519. - BlitzBlank is a commodity and supports the usual commodity tooltypes.
  520. - BlitzBlank uses a second task to determine if the module has stopped due
  521.   to heavy CPU load. This causes BlitzBlank to switch to a completely black
  522.   screen.
  523. - BlitzBlankPrefs is completely controlable with the keyboard.
  524. - BlitzBlank's screenmode requester is fully font sensitiv and (contrary to
  525.   the OS 2.1/3.x ASL-requester) controlable with the keyboard.
  526. - BlitzBlank is the result of more than a year development.
  527. - BlitzBlank and all supplied programs have been tested with Enforcer and
  528.   Mungwall and didn't lose any memory during tests.
  529. - BlitzBlank and BlitzBlankPrefs can be started from shell.
  530. - BlitzBlank uses almost no CPU time (0.010% on an A4000). If the mouse
  531.   blanker is not activated it uses non at all. Even if the mouse is moved
  532.   the used CPU time is very low.
  533. @endnode
  534. @node P12 "Problems?"
  535. Possible Problems:
  536. ------------------
  537. Problem:  BlitzBlank doesn't work at all.
  538. Solution: AmigaOS 2.04 or higher isn't installed.
  539. Problem:  Some modules won't work.
  540. Solution: Not enough memory.
  541. Problem:  Configurations are not saved properly and XPK/XFH is in use.
  542. Solution: Install the most recent XPK/XFH version.
  543. Problem:  BlitzBlank, BlitzBlankPrefs or a module crashes.
  544. Solution: Contact the author.
  545. @endnode
  546. @node P13 "Graphic Cards"
  547. BlitzBlank and Graphic Cards:
  548. -----------------------------
  549. BlitzBlank has been tested with the PicassoII and Piccolo. The following
  550. must be regarded if you intend to use a graphic card screen:
  551. - The "Nasty" option should be turned off with the Spot and Tiles module.
  552. - You shouldn't use more than one spot in the Spot module.
  553. - The "buffering" option should not be used since double buffering is
  554.   either very slow or won't work at all with graphic cards.
  555. - Some modules will crash if you are using EGS 7.1 (Piccolo) and you are
  556.   running the module on a Piccolo screen. Since these problems didn't show
  557.   up when we were running a quick test with the CyberGfx 40.40 system (on
  558.   the same setup) it seems like EGS 7.1 is the problem and not the modules.
  559. @endnode
  560. @node P14 "Bugs? Ideas for improvment?"
  561. Bugs and ideas for improvment:
  562. ------------------------------
  563. If there should occure any errors please contact the @{" Author " link P15} with a
  564. detailed description of the error and your machine configuation (model, OS version,
  565. additional hardware, etc.).
  566. The same applies to all kinds of ideas and comments.
  567. @endnode
  568. @node P15 "Author"
  569. Author:
  570. -------
  571. Thomas B
  572. Gartenstr. 16
  573. D-76761 R
  574. lzheim
  575. Germany
  576. Mailbox:   Amiga Inside II, ++49-7272-76611 (07272/76611)
  577. FIDO:      Thomas Boerkel, 2:2476/541.0
  578. Usenet:    Thomas_Boerkel@amiga_inside2.schiele-ct.de
  579. Amiganet:  Thomas Boerkel, 39:173/60.0
  580. KAMInet:   Thomas Boerkel, 82:100/7.0
  581. Rally-Box: Tom
  582. @endnode
  583. @node P16 "Copyright/Warranty"
  584. Copyright and warranty:
  585. -----------------------
  586. BlitzBlank and BlitzBlankPrefs are copyright 1993-95 by Thomas B
  587. rkel.
  588. BlitzBlank is GIFTware. If you like it you can send me a gift (money etc.)
  589. or at least write a postcard or a mail. But this is not a must.
  590. It is prohibited to supply BlitzBlank with commercial products or with
  591. PD/FD disks with a price higher then DM 3.-/US$2.
  592. BlitzBlank may be supplied on the Aminet/Fish/Saar-AG CDs.
  593. BlitzBlank may be freely copied but no part may be altered.
  594. BlitzBlank may only be copied as a complete and unchanged archive.
  595. BlitzBlank must not be sold with profit.
  596. The sourcecodes are only supplied to give you an idea how to program
  597. certain modules. They may not be used in another package without the prior
  598. agreement of the respective authors. The same applies for the graphics.
  599. There is NO warranty for BlitzBlank. The use of BlitzBlank is at your own
  600. risk. The author is in NO way responsible for ANY damage inflicted by
  601. BlitzBlank.
  602. The same applies for the BlitzBlank modules.
  603. @endnode
  604. @node P17 "Thanks go to..."
  605. Thanks go to:
  606. -------------
  607. My special thanks go to:
  608. Alexander Wiggert for betatests, ideas, tips and pushing me forwards ;-))))
  609. Also for the the english translation of the documentation!
  610. Dirk Farin for ideas and many modules! :-)))
  611. Kenneth Fribert for bugreports, ideas and the danish translation.
  612. rgen Denner for betatests, advice, the idea for Lines and for Splines.
  613. Also to (in alphabetical order):
  614. - Matthias Bock for betatests, tips
  615. - Wolfgang B
  616. rkel for the mathematical background for Pyro
  617. - Ex-Commodore-people for the Amiga and it's mighty operation system
  618. - Brian Larson for bugreports
  619. - Mark Rose for betatests and the MagicWB icons
  620. - Stefan Scholl for betatests
  621. - Mathias Supp for betatests and ideas
  622. - Christian A. Weber for the iff.library
  623. - Peter Wenz for betatests
  624. @endnode
  625. @node P18 "History"
  626. History of BlitzBlank:
  627. ----------------------
  628. V1.00:
  629. ------
  630. First public release.
  631. V1.01:
  632. ------
  633. Bugfix for 1.00.
  634. V2.00:
  635. ------
  636. Version for the programing contest of a german Amiga magazine.
  637. Unfortunately it didn't win and was never published.
  638. V2.50:
  639. ------
  640. - Almost totally rewritten.
  641. - MUI-GUI.
  642. - Modules are significantly shorter.
  643. - New options.
  644. - Significantly more stable.
  645. - Less CPU time consuming.
  646. - Splitted in blanker and prefs
  647. - Arexx port.
  648. - Many new modules.
  649. V2.50a:
  650. -------
  651. - Enforcer-Hit in BB.Lines killed
  652. - Minimum screen depth for BB.Radar set to 3 (crash with 2)
  653. V2.50b:
  654. -------
  655. - Black screen between the modules in randommode has the correct overscan
  656.   dimensions, black border and correct ModeID
  657. - Fast Unblank even with heavy CPU
  658. V2.60:
  659. ------
  660. *BlitzBlank:
  661. - BlitzBlank ported to C (-> shorter and faster)
  662. - Fuzzy Mouse bug killed: Works better now
  663. - Default Blank/Mousetime is correct
  664. - Mouseblanking is 100% compatible to the Commodore Mouseblanker
  665. - Tooltype/Parameter NASTYMOUSEBLANK no longer exists
  666. - Reblank function added, currently set to 5 seconds
  667. - Blackout works correct in randommode
  668. - If a module cannot be found, Blackout is used instead
  669. - WB will not be examined if not really necessary (and opened therefore)
  670. - Internal bugfixes and changes
  671. *BlitzBlankPrefs:
  672. - BBPrefs crashed when quitting, if there was no .info
  673. - Cleaned up ARexx routine of BBPrefs
  674. - Fuzzy Mouse is adjustable between 0 and 30
  675. - Selected modules will always be saved when clicking Use/Save
  676. *Modules:
  677. - Clock has the right priority earlier in analog mode
  678. - 24h-mode in Clock/Digital can really be switched off
  679. - Slideshow also scans subdirectories
  680. - Lines has a better palette
  681. - Delay in Lines implemented
  682. - Clock, Mosaic, Spot, Tiles, Worms have a correct aspect ratio
  683. - Snow has a new parameter (max. snowheight)
  684. - Noise and Fountain are fading out in randommode
  685. - New modules: ASwarm, FlyingToaster, Fractal, Goats, Gravity, Maze, Plasma,
  686.                Skyline, StarField, TicTacToe
  687. *blitzblank.library:
  688. - Interrupting blanking with the right mousebutton no longer holds the
  689.   modulescreen
  690. - New library functions: BBL_RainbowPalette(), BBL_RemainingTime(),
  691.                          BBL_CloneFirstScreen()
  692. - New variables in BB_Screeninfo: xpixelsize, ypixelsize
  693. - locale strings were freed to early
  694. @endnode
  695. @node mui "MUI"
  696.                           This application uses
  697.                         MUI - MagicUserInterface
  698.                 (c) Copyright 1993/94 by Stefan Stuntz
  699. MUI is a system to generate and maintain graphical user interfaces. With
  700. the  aid  of  a  preferences program, the user of an application has the
  701. ability to customize the outfit according to his personal taste.
  702. MUI is distributed as shareware. To obtain a complete package containing
  703. lots of examples and more information about registration please look for
  704. a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
  705. your local bulletin boards or on public domain disks.
  706.           If you want to register directly, feel free to send
  707.                          DM 30.-  or  US$ 20.-
  708.                                   to
  709.                              Stefan Stuntz
  710.                         Eduard-Spranger-Stra
  711.                              80935 M
  712. nchen
  713.                                 GERMANY
  714. @endnode
  715. @node modules "Modules"
  716. Every module (except Blackout) has it's own preferences window.
  717. Pressing the HELP-key in this window will display the module's
  718. documentation.
  719. The following non module specific options are available:
  720. Save    - The current preferences will be saved
  721. Test    - Test the current preferences
  722. Screen  - Select the screen mode for this module
  723. Info    - About the module
  724. Presets - Reset the preferences to default values
  725. Cancel  - Leave the window without saving
  726. These options are not available in all modules.
  727. The following modules are included:
  728. -----------------------------------
  729. @{" Blackout       " link Blackout}
  730. @{" AmigaSign      " link AmigaSign}
  731. @{" ASwarm         " link Aswarm}
  732. @{" Butterfly      " link Butterfly}
  733. @{" Clock          " link Clock}
  734. @{" Crumble        " link Crumble}
  735. @{" Dissolve       " link Dissolve}
  736. @{" Electric       " link Electric}
  737. @{" Execute        " link Execute}
  738. @{" Fade           " link Fade}
  739. @{" Flash          " link Flash}
  740. @{" FlyingToaster  " link FlyingToaster}
  741. @{" Fountain       " link Fountain}
  742. @{" Fractal        " link Fractal}
  743. @{" Goats          " link Goats}
  744. @{" Gravity        " link Gravity}
  745. @{" Guru           " link Guru}
  746. @{" Life           " link Life}
  747. @{" Lines          " link Lines}
  748. @{" Mandel         " link Mandel}
  749. @{" Maze           " link Maze}
  750. @{" Melt           " link Melt}
  751. @{" Mosaic         " link Mosaic}
  752. @{" Noise          " link Noise}
  753. @{" PatternCycling " link PatternCycling}
  754. @{" Plasma         " link Plasma}
  755. @{" Pyro           " link Pyro}
  756. @{" Radar          " link Radar}
  757. @{" Skyline        " link Skyline}
  758. @{" Slideshow      " link Slideshow}
  759. @{" Snow           " link Snow}
  760. @{" Splines        " link Splines}
  761. @{" Spot           " link Spot}
  762. @{" StarField      " link StarField}
  763. @{" Text           " link Text}
  764. @{" TicTacToe      " link TicTacToe}
  765. @{" Tiles          " link Tiles}
  766. @{" Tunnel         " link Tunnel}
  767. @{" Worms          " link Worms}
  768. @{" Worms2         " link Worms2}
  769. @endnode
  770. @node Blackout "Blackout"
  771. Blackout:
  772. ---------
  773. This is the build in blank module of BlitzBlank. It's always available. It
  774. just opens a black 320x200x1 screen in the mode of the frontmost screen.
  775. @endnode
  776. @node AmigaSign "AmigaSign"
  777. AmigaSign:
  778. ----------
  779. The famous Amiga symbol flies over the screen and rotates.
  780. Parameters:
  781.   Movement  - In which direction the symbol should fly
  782.   Rotspeed  - How fast the symbol should rotate (0=normal speed)
  783.   Speed     - How fast the symbol should fly
  784.   Buffering - Switches the Double-Buffering on/off
  785. AmigaSign is Copyright by @{" Thomas B
  786. rkel " link P15}.
  787. Graphics are by Alexander Wiggert
  788. @endnode
  789. @node ASwarm "ASwarm"
  790. ASwarm:
  791. -------
  792. Bees and wasps fly around. The bees chase the wasps.
  793. Parameters:
  794.   Speed      - How fast they fly
  795.   Color      - Colorcycling yes/no
  796.   Aim        - Where the bees aim
  797.   Bees       - Number of bees
  798.   Wasps      - Number of wasps
  799.   Bee Accel  - Acceleration of the bees
  800.   Wasp Accel - Acceleration of the wasps
  801. Original source by Alexander Kneer and Michael D. Bayne.
  802. Ported to BlitzBlank by @{" Thomas B
  803. rkel " link P15}.
  804. @endnode
  805. @node Butterfly "Butterfly"
  806. Butterfly:
  807. ----------
  808. Colorful butterflies are fluttering over the screen.
  809. Parameters:
  810.   Butterflies   - Number of butterflies
  811.   Minimum Speed - The minimum speed of a butterfly
  812.   Maximum Speed - The maximum speed of a butterfly
  813.   Wing Speed    - The speed of the fluttering of the wings
  814.   Buffering     - Switches Double-Buffering on/off
  815. Butterfly is Copyright by @{" Thomas B
  816. rkel " link P15}.
  817. Graphics are by Asha Develder.
  818. @endnode
  819. @node Clock "Clock"
  820. Clock:
  821. ------
  822. This module shows either an analogous or digital clock on the screen.
  823. General Parameters:
  824.   Movement  - In which direction the clock should fly
  825.   Speed     - How fast the clock should fly
  826.   Seconds   - Switches the seconds on/off
  827.   Buffering - Switches the Double-Buffering on/off
  828.   Optimizer - Always tries to draw the least possible number of points
  829. Analogous Parameters:
  830.   Size      - Size of the clock in percent of the screen size
  831.   Circle    - Draw the outer circle yes/no
  832. Digital Parameters:
  833.   Font      - Which font should be used (even proportional and color
  834.               fonts are usable)
  835.   Color     - Color (if it isn't a color font)
  836.   24h       - 12/24 hour display
  837.   Cache     - Calculate in advance
  838.               (faster, but uses more CHIP-RAM)
  839. Clock is Copyright by @{" Thomas B
  840. rkel " link P15}.
  841. @endnode
  842. @node Crumble "Crumble"
  843. Crumble:
  844. --------
  845. This module "crumbles" the current screen from top to bottom.
  846. Parameters:
  847.   Speed           - How fast the screen will be crumbled
  848.   Dark Background - A dark background will remain
  849.   Brightness      - The screen's brightness during the effect
  850.   Delay           - Delay till the brigthness is reached
  851. Crumble is Copyright by @{" Thomas B
  852. rkel " link P15}.
  853. @endnode
  854. @node Dissolve "Dissolve"
  855. Dissolve:
  856. ---------
  857. The front-screen (Workbench) will slowly dissolve.
  858. parameter:
  859.   speed  [1-5000]  number of pixels to be removes per frame.
  860. version 1.0
  861. Dissolve is Copyright by @{" Dirk Farin " link DirkFarin}.
  862. @endnode
  863. @node Electric "Electric"
  864. Electric:
  865. ---------
  866. High voltage in your monitor.
  867. parameter:
  868.   details  [10-100]  the higher the better but the slower
  869. version 1.1
  870. Electric is Copyright by @{" Dirk Farin " link DirkFarin}.
  871. @endnode
  872. @node Execute "Execute"
  873. Execute:
  874. --------
  875. This module executes a program. It MUST be breakable with CTRL-C or CTRL-D
  876. or must terminate itself.
  877. Parameters:
  878.   Execute       - Path and name of the program to execute
  879.   Arguments     - Parameter for the program
  880.   Stack         - Stacksize (default is 4000)
  881.   CTRL-C        - Program will be stopped with CTRL-C
  882.   CTRL-D        - Program will be stopped with CTRL-D
  883.   Final Command - This command will be executed at break time
  884.                   (optional)
  885. Execute is Copyright by @{" Thomas B
  886. rkel " link P15}.
  887. @endnode
  888. @node Fade "Fade"
  889. Fade:
  890. -----
  891. This module fades out the current screen smoothly. AGA/OS 3.0 is supported
  892. (smoother fading).
  893. Parameters:
  894.   Brightness - The remaining screen brightness
  895.   Delay      - Delay till the brigthness is reached
  896. Fade is Copyright by @{" Thomas B
  897. rkel " link P15}.
  898. @endnode
  899. @node Flash "Flash"
  900. Flash:
  901. ------
  902. This module displays a thunderstorm on the screen.
  903. Parameters:
  904.   Flashes   - The maximum number of flashes
  905.   Highlight - The Background will flash with the flashes
  906. Flash is Copyright by @{" Thomas B
  907. rkel " link P15}.
  908. @endnode
  909. @node FlyingToaster "FlyingToaster"
  910. FlyingToaster:
  911. --------------
  912. Toasters are flying around your screen.
  913. Parameters:
  914.   Toasters - Number of toasters
  915.   Speed    - How fast the toasters fly
  916. Original source & gfx by Gernot Reisinger and Michael D. Bayne.
  917. Ported to BlitzBlank by @{" Thomas B
  918. rkel " link P15}.
  919. @endnode
  920. @node Fountain "Fountain"
  921. Fountain:
  922. ---------
  923. Points flying over the screen.
  924. parameters:
  925.   points    [10-500]   how many points
  926.   spread    [10-100]   how much it will spread horizontally
  927. note:
  928.   screen modes with 2 or 3 planes are sufficient.
  929. version 1.2
  930. Fountain is Copyright by @{" Dirk Farin " link DirkFarin}.
  931. @endnode
  932. @node Fractal "Fractal"
  933. Fractal:
  934. --------
  935. Fractals will be drawn on the screen.
  936. Original source by Olaf Seibert and Alexander Kneer.
  937. Ported to BlitzBlank by @{" Thomas B
  938. rkel " link P15}.
  939. @endnode
  940. @node Goats "Goats"
  941. Goats:
  942. ------
  943. Simulation of herders and goats on your screen.
  944. Parameters:
  945.   Delay        - Global speed
  946.   Herders      - Number of herders, which plant grass
  947.   Goats        - Number of goats
  948.   Reproduction - Reproduction
  949.   Screen       - Use new screen or top screen
  950. Original source by Steve Akers.
  951. Ported to BlitzBlank by @{" Thomas B
  952. rkel " link P15}.
  953. @endnode
  954. @node Gravity "Gravity"
  955. Gravity:
  956. --------
  957. Draws some points that behave like equally charged masses.
  958. parameters:
  959.   number of points [2-30]  how many points are flying around
  960.   attraction [0-20]        the strength of the gravitation
  961.   distraction [0-10]       the strength of the charge
  962.   point size  [1-3]        how big the points should be drawn
  963.                            (useful for high screen-resolutions)
  964. remark:
  965.   a fast (co)processor is recommended!
  966. version 1.0
  967. Gravity is Copyright by @{" Dirk Farin " link DirkFarin}.
  968. @endnode
  969. @node Guru "Guru"
  970. Guru:
  971. -----
  972. The loved Guru appears.
  973. parameters:
  974.   none
  975. version 1.1
  976. Guru is Copyright by @{" Dirk Farin " link DirkFarin}.
  977. @endnode
  978. @node Life "Life"
  979. Life:
  980. -----
  981. Simulates the game of life.
  982. parameters:
  983.   resolution   [10-100]  the number of squares horizontally
  984.                          across the screen
  985.   refreshdelay [10-500]  time delay between a new start with
  986.                          a new random pattern
  987. version 1.1
  988. Life is Copyright by @{" Dirk Farin " link DirkFarin}.
  989. @endnode
  990. @node Lines "Lines"
  991. Lines:
  992. ------
  993. This module draws colored lines on the screen. The idea was from J
  994. Denner.
  995. Parameters:
  996.   Lines - Number of lines
  997. Lines is Copyright by @{" Thomas B
  998. rkel " link P15}.
  999. @endnode
  1000. @node Mandel "Mandel"
  1001. Mandel:
  1002. -------
  1003. Draws pictures of the Mandelbrot-set.
  1004. remark:
  1005.   a fast processor is recommended!
  1006. version 1.0
  1007. Mandel is Copyright by @{" Dirk Farin " link DirkFarin}.
  1008. @endnode
  1009. @node Maze "Maze"
  1010. Maze:
  1011. -----
  1012. Creates a maze and finds a way out of it.
  1013. Parameters:
  1014.   Cell Size          - Width of the ways
  1015.   Solve Delay        - How fast the solution will be found
  1016.   Multicolored Trail - Leave a multicolored trail
  1017. Original source by Michael D. Bayne.
  1018. Ported to BlitzBlank by @{" Thomas B
  1019. rkel " link P15}.
  1020. @endnode
  1021. @node Melt "Melt"
  1022. Melt:
  1023. -----
  1024. This module "melts" the current screen.
  1025. Parameter:
  1026.   Speed         - How fast the effect will run
  1027.   Size          - Width of the melt units
  1028.   Refresh cycle - Delay till the screen will be refreshed
  1029.   Brightness    - The remaining brightness
  1030.   Delay         - Delay till the brightness is reached
  1031. Melt is Copyright by @{" Thomas B
  1032. rkel " link P15}.
  1033. @endnode
  1034. @node Mosaic "Mosaic"
  1035. Mosaic:
  1036. -------
  1037. This module "mosaics" the current screen.
  1038. Parameters:
  1039.   Speed         - How fast the effect will run
  1040.   Size          - Size of the rectangles
  1041.   Refresh cycle - Delay till the screen will be refreshed
  1042.   Brightness    - The remaining brightness
  1043.   Delay         - Delay till the brightness is reached
  1044. Mosaic is Copyright by @{" Thomas B
  1045. rkel " link P15}.
  1046. @endnode
  1047. @node Noise "Noise"
  1048. Noise:
  1049. ------
  1050. Creates white noise on your monitor, as it can be seen on tv-sets.
  1051. parameters:
  1052.   brightness [0-100]  how many percent of the screen will be white
  1053. note:
  1054.   The more colors, the better the effect.
  1055. version 1.2
  1056. Noise is Copyright by @{" Dirk Farin " link DirkFarin}.
  1057. @endnode
  1058. @node PatternCycling "PatternCycling"
  1059. PatternCycling:
  1060. ---------------
  1061. Draws some nice color-patterns and applies color-cycling
  1062. to them.
  1063. parameters:
  1064.   rings, bars, waves   selects which patterns will be drawn.
  1065.   speed   [-10 - 10]   selects speed and direction of
  1066.                        color-cycling.
  1067.   change  [0-300]      time between new patterns
  1068.                        (0 means no change)
  1069. remark:
  1070.   OS 3.0 and a 256-color-screen recommended.
  1071. version 1.0
  1072. PatternCycling is Copyright by @{" Dirk Farin " link DirkFarin}.
  1073. @endnode
  1074. @node Plasma "Plasma"
  1075. Plasma (Written in BlitzBasic ][)
  1076. ======---------------------------
  1077. Draws a plasma like pattern using your chosen screenmode and number of
  1078. colours, and then cycles the colours so that the plasma moves.
  1079. Parameters:
  1080.   Pattern Type - The pattern type just alters the palette used
  1081.                  to create the plasma.  The choices are:
  1082.                  Plasma, Clouds, Electrical.  Rather than explaining
  1083.                  them, just look at it.
  1084.   Colour Cycle Rate - The rate at which the colours are cycled, ranging
  1085.                       from  Very Fast  to  Slow.
  1086.   Brightness - The brightness level of the palette, ranging from 0 which
  1087.                is the least bright, to 4 which is very bright.
  1088.   Screen Mode - Choice of screenmode is very important with this
  1089.                 module.  For higher resolution screenmodes it takes
  1090.                 a long time to draw the pattern.  Lower resolutions
  1091.                 still look really good, and don't take nearly so long.
  1092.                 The number of colours make a negligable difference to
  1093.                 the time taken to draw the pattern, and more colours
  1094.                 look MUCH better.
  1095. Plasma is Copyright by @{" Daniel Pink " link DanielPink}.
  1096. @endnode
  1097. @node Pyro "Pyro"
  1098. Pyro:
  1099. -----
  1100. This module diplays a firework on the screen. The mathematical
  1101. background for this module is from Wolfgang B
  1102. rkel.
  1103. Parameter:
  1104.   Flares        - Number of flares
  1105.   Double pixels - Exploding flares are doubled 
  1106.                   (flares can be seen better, but it's slower)
  1107. Pyro is Copyright by @{" Thomas B
  1108. rkel " link P15}.
  1109. @endnode
  1110. @node Radar "Radar"
  1111. Radar:
  1112. ------
  1113. Showing a radar-screen.
  1114. parameters:
  1115.   speed              [2-100]  speed of rotation
  1116.   radar decay        [1-4]    decay rate of radar-beam
  1117.                               (1 - fast decay, 4 - slow decay)
  1118.   object decay       [1-10]   decay rate of the objects
  1119.                               (1 - fast decay, 10 - visible till beam appears again)
  1120.   objects            [0-100]  number of visible objects
  1121. version 1.1
  1122. Radar is Copyright by @{" Dirk Farin " link DirkFarin}.
  1123. @endnode
  1124. @node Skyline "Skyline"
  1125. Skyline:
  1126. --------
  1127. Draws some skyscrapers at evening (or night) with a
  1128. thunderstorm, stars, an airplane, shooting stars ...
  1129. parameters:
  1130.   thunderstorm   [0-9]   how hard the thunderstorm is  (0 - no thunderstorm)
  1131.   airplane       [0-9]   how frequent airplanes can be seen
  1132.   shooting star  [0-9]   how frequent shooting stars can be seen
  1133.   warning light          if an air-traffic warning light is on a skyscraper
  1134.   stars          [0-200] how many stars will be visible
  1135.   sunlight       [0-9]   how much sunlight is still visible
  1136.   thunder volume [0-64]  volume of the thunder (0 for off)
  1137. version 1.1
  1138. Skyline is Copyright by @{" Dirk Farin " link DirkFarin}.
  1139. Idea, thunder-sound and some code by Jason Sonnenschein.
  1140. @endnode
  1141. @node Slideshow "Slideshow"
  1142. Slideshow:
  1143. ----------
  1144. This module shows a slideshow.
  1145. The viewer must be interruptable with CTRL-C to be used with this module
  1146. (MultView from OS 3.0 doesnt't work, but the 3.1-version does).
  1147. Parameter:
  1148.   Viewer    - The viewer program
  1149.   Parameter - Additional parameters for the viewer
  1150.   Directory - The picture-directory
  1151.   Pattern   - Namepattern for the pictures (e.g. #?.IFF)
  1152.   Stack     - Stacksize for the viewer
  1153.   Delay     - Delay between two pictures
  1154.   Buffering - Load the picture in the background
  1155. Note:
  1156. The buffer-option prevents the WorkBench from being displayed between
  1157. 2 pictures and works best, if the viewer first loads the picture and
  1158. then brings it's screen to front.
  1159. Slideshow is Copyright by @{" Thomas B
  1160. rkel " link P15}.
  1161. @endnode
  1162. @node Snow "Snow"
  1163. Snow:
  1164. -----
  1165. Lots of snowflakes falling down and slowly building a layer of snow
  1166. at the bottom of the screen.
  1167. parameters:
  1168.   snowflakes       [10-500]  number of snowflakes on screen
  1169.   wind velocity    [0-10]    0-no wind, 10-stormy
  1170.   wind probability [0-100]   what percentage of time there is wind
  1171.   snow height      [1-100]   percentage of screen that will fill with snow
  1172. note:
  1173.   screen modes with 2 or 3 planes are sufficient.
  1174. version 1.2
  1175. Snow is Copyright by @{" Dirk Farin " link DirkFarin}.
  1176. @endnode
  1177. @node Splines "Splines"
  1178. Splines:
  1179. --------
  1180. Splines draws spline curves on the screen.
  1181. Parameter:
  1182.   Modes - Straight, Bouncing, Various
  1183. For every mode:
  1184.   Fixpoints    - Number of points in a curve
  1185.   Splines      - Number of Splines
  1186.   Spline Speed - Speed of the Splines
  1187.   Random Range - Time till the next random configuration takes place
  1188. Splines is Copyright by @{" J
  1189. rgen Denner " link J
  1190. rgenDenner}.
  1191. @endnode
  1192. @node Spot "Spot"
  1193. Spot:
  1194. -----
  1195. Moves spotlight(s) over the current screen.
  1196. Paramteres:
  1197.   Speed      - How fast the spots are moving
  1198.   Spots      - Number of spots
  1199.                (if more than 1 are selected double-buffering will
  1200.                 be turned on automatically)
  1201.   Size       - Size of the spots
  1202.   Brightness - The remaining screen brightness
  1203.   Delay      - Delay till the brightness is reached
  1204.   Update     - Screen underneath the spots will permanently be updated
  1205.   Nasty      - Use non system friendly routines
  1206. The "Nasty" option tries to make the movements of a single spot flicker
  1207. free. It's not system friendly and won't work with graphic cards. If there
  1208. are more than one spot selected the option has no meaning since
  1209. double-buffering is activ anyway.
  1210. Spot is Copyright by @{" Thomas B
  1211. rkel " link P15}.
  1212. @endnode
  1213. @node StarField "StarField"
  1214. StarField:
  1215. ----------
  1216. Flight through a starfield.
  1217. Parameters:
  1218.   Stars - Number of stars
  1219.   Speed - Speed of the flight
  1220.   Color - Colored or grey stars
  1221. StarField is Copyright by @{" Matthias Bock " link MatthiasBock}.
  1222. Ported from Modula to C and from BB 1.x to BB 2.x by Thomas B
  1223. rkel.
  1224. @endnode
  1225. @node Text "Text"
  1226. Text:
  1227. -----
  1228. Shows text on the screen either as message or scrolling.
  1229. General parameters:
  1230.   Font      - Which font should be used
  1231.              (even proportional and color fonts are usable)
  1232.   Color     - Color (if it isn't a color font)
  1233.   Speed     - How fast the text will be moved
  1234.   Buffering - Switches double-buffering on/off
  1235. Scrolling-parameters:
  1236.   Text      - The text to be displayed
  1237.   Position  - Position of the text on the screen
  1238.   Cache     - Draw the text in advance
  1239.               (faster, but uses more CHIP-RAM)
  1240. Message-parameters:
  1241.   Movement  - Direction of the text movement
  1242.   Line 1-4  - The message to be diplayed. Lower lines that are
  1243.               empty won't be displayed. If the message won't fit
  1244.               on the screen with the selected font the module
  1245.               won't do anything.
  1246. Text is Copyright by @{" Thomas B
  1247. rkel " link P15}.
  1248. @endnode
  1249. @node TicTacToe "TicTacToe"
  1250. TicTacToe:
  1251. ----------
  1252. The computer plays TicTacToe.
  1253. Parameters:
  1254.   Size  - Size of playfield
  1255.   Delay - Delay between moves
  1256.   Mode  - Normal:   There's a way to win.
  1257.           Wargames: "Funny, the only way to win is not to play at all!"
  1258.   Move  - Playfield on differnt positions on screen.
  1259. TicTacToe is Copyright by @{" Stefan Scholl " link StefanScholl}.
  1260. @endnode
  1261. @node Tiles "Tiles"
  1262. Tiles:
  1263. ------
  1264. Tiles splits the current screen into small pieces and moves them around
  1265. (simulates a well-known game).
  1266. Parameters:
  1267.   Border     - The border of the rectangles
  1268.   Speed      - The speed of the game
  1269.   Size       - The size of the rectangles in percent of the screen width
  1270.   Nasty      - Use non system friendly routines
  1271.   Brightness - The remaining brightness of the screen
  1272.   Delay      - Delay till the brightness is reached
  1273. Note:
  1274. The option "Nasty" tries to make the motion smoother, but is not quite
  1275. system-compliant and doesn't work with graphic cards.
  1276. Tiles is Copyright by @{" Thomas B
  1277. rkel " link P15}.
  1278. @endnode
  1279. @node Tunnel "Tunnel"
  1280. Tunnel:
  1281. -------
  1282. Flight through a tunnel.
  1283. parameters:
  1284.   speed       - how fast you want to fly
  1285.   rectangles  - how many rectangles the tunnel has
  1286.   length      - the length of the tunnel
  1287.   aspect      - the aspect ratio of the tunnel rectangles
  1288.                 (10 means your monitors-aspect,
  1289.                 <10 is wider and >10 is taller)
  1290.   x wabbel    - how fast the tunnel will bend horizontally
  1291.   y wabbel    - how fast the tunnel will bend vertically
  1292.   x amplitude - how much the tunnel will bend horizontally
  1293.   y amplitude - how much the tunnel will bend vertically
  1294. version 1.0
  1295. Tunnel is Copyright by @{" Dirk Farin " link DirkFarin}.
  1296. @endnode
  1297. @node Worms "Worms"
  1298. Worms:
  1299. ------
  1300. Worms draws small, hungry worms on the current screen.
  1301. Parameters:
  1302.   Worms      - Number of worms
  1303.   Lenght     - Lenght of the worms
  1304.   Size       - Size of the worm segments
  1305.   Brightness - The remaining screen brightness
  1306.   Delay      - Delay till the brightness is reached
  1307. Worms is Copyright by @{" Thomas B
  1308. rkel " link P15}.
  1309. @endnode
  1310. @node Worms2 "Worms2"
  1311. Worms2:
  1312. -------
  1313. Colorful worms crawling over the screen.
  1314. parameters:
  1315.   number of worms [1-50]   how many
  1316.   length          [10-200] length of a worm
  1317.   crazyness       [3-30]   crawl straight on or turn most time
  1318.   speed           [1-4]    speed of the worms
  1319. note:
  1320.   screen modes with 4 or 5 are best.
  1321. version 1.1
  1322. Worms2 is Copyright by @{" Dirk Farin " link DirkFarin}.
  1323. @endnode
  1324. @node modauthors "Moduleauthors"
  1325. The modules of this release were programmed by the following authors:
  1326. @{" Thomas B
  1327. rkel " link P15}
  1328. @{" J
  1329. rgen Denner " link J
  1330. rgenDenner}
  1331. @{" Dirk Farin    " link DirkFarin}
  1332. @{" Daniel Pink   " link DanielPink}
  1333. @{" Stefan Scholl " link StefanScholl}
  1334. @{" Matthias Bock " link MatthiasBock}
  1335. @endnode
  1336. @node J
  1337. rgenDenner "Moduleauthors"
  1338. rgen Denner
  1339. Landstr. 116
  1340. D-69198 Schriesheim
  1341. Germany
  1342. @endnode
  1343. @node DirkFarin "Moduleauthors"
  1344. Dirk Farin
  1345. Kapellenweg 15
  1346. D-72070 T
  1347. bingen
  1348. Germany
  1349. EMail: farindk@trick.informatik.uni-stuttgart.de
  1350. @endnode
  1351. @node DanielPink "Moduleauthors"
  1352. Postal Address:
  1353.      Daniel Pink
  1354.      26 Elderbek Close,
  1355.      Cheshunt,
  1356.      Hertfordshire,
  1357.      EN7 6HS.
  1358.      England.
  1359. E-Mail: (Until July 1995)
  1360.      D.C.J.Pink@Herts.ac.uk
  1361. @endnode
  1362. @node StefanScholl "Moduleauthors"
  1363. EMail: Stefan Scholl <stesch@sks.inka.de>
  1364. @endnode
  1365. @node MatthiasBock "Moduleauthors"
  1366. EMail: Matthias Bock <starfox@stargate.mayn.sub.de>
  1367. @endnode
  1368. @node newmods "New modules?"
  1369. Modules I like to have or are already planned:
  1370. - Something with 3D graphics
  1371. - all other kind of gags
  1372. @endnode
  1373.